Clarify statements about ignoring/checking in Cargo.lock
authorCarol (Nichols || Goulding) <carol.nichols@gmail.com>
Sun, 15 May 2016 14:39:40 +0000 (10:39 -0400)
committerCarol (Nichols || Goulding) <carol.nichols@gmail.com>
Sun, 15 May 2016 14:39:40 +0000 (10:39 -0400)
src/doc/guide.md

index 5819878a9d80f8b5396fb5280854149ef16ee046..15f87fcf8360cd7c245dd754ad9b3a7a7221628e 100644 (file)
@@ -247,8 +247,13 @@ about them, here’s a summary:
 
 * `Cargo.toml` is about describing your dependencies in a broad sense, and is written by you.
 * `Cargo.lock` contains exact information about your dependencies. It is maintained by Cargo and should not be manually edited.
-* If you’re building a library, put `Cargo.lock` in your `.gitignore`.
-* If you’re building an executable, check `Cargo.lock` into `git`.
+
+If you’re building a library that other projects will depend on, put
+`Cargo.lock` in your `.gitignore`. If you’re building an executable like a
+command-line tool or an application, check `Cargo.lock` into `git`. If you're
+curious about why that is, see ["Why do binaries have `Cargo.lock` in version
+control, but not libraries?" in the
+FAQ](faq.html#why-do-binaries-have-cargolock-in-version-control-but-not-libraries).
 
 Let’s dig in a little bit more.